Approval Service

This service defines methods for managing cover persons and approvals for work and project times.

GetOpenApprovalCountForIdentity

This method returns the number of open approvals for work and project times of the current identity.

List<ApprovalPanelsInformationDto> GetOpenApprovalCountForIdentity(
 out TpFault fault,
 TpAuthentication authentication);

Needed Permission	approval@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
return value		List containing the number of open approvals.

GetOpenProjectTimeApprovalsForIdentity

This method returns the open project time approvals of the current identity.

List<ProjectTimeApprovalItemDto> GetOpenProjectTimeApprovalsForIdentity(
 out TpFault fault,
 TpAuthentication authentication);

Needed Permission	approval@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
return value		List containing the open project time approvals.

GetOpenWorkTimeApprovalsForIdentity

This method returns the open work time approvals of the current identity and organization unit.

List<WorkTimeApprovalItemDto> GetOpenWorkTimeApprovalsForIdentity(
 out TpFault fault,
 TpAuthentication authentication,
 Guid selectedOrgaUnitId);

Needed Permission	approval@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
selectedOrgaUnitId		ID of the selected organization unit.
return value		List containing the open work time approvals.

GetCoverPersons

This method returns the cover persons for the specified users and approval request origin.

List<CoverPersonDto> GetCoverPersons(
 out TpFault fault,
 TpAuthentication authentication,
 List<Guid> userIds,
 ApprovalOrigin origin);

Needed Permission	approval@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userIds		List of user IDs.
origin		Origin of the approval request.

GetApprovers

This method returns all approvers for the specified users and approval request origin.

List<ApproverDto> GetApprovers(
 out TpFault fault,
 TpAuthentication authentication,
 List<Guid> userIds,
 ApprovalOrigin origin);

Needed Permission	approval@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userIds		List of user IDs for which approvers shall be retrieved.
origin		Origin of the approval request.
return value		List containing the approvers.

SaveApprover

This method saves an approver.

ApproverDto SaveApprover(
 out TpFault fault,
 TpAuthentication authentication,
 ApproverSaveDto approver);

Needed Permission	approval@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
approver		Approver to save.
return value		The saved approver.

DeleteApprovers

This method deletes the approvers for the specified users.

void DeleteApprovers(
 out TpFault fault,
 TpAuthentication authentication,
 List<Guid> userIds,
 ApprovalOrigin origin);

Needed Permission	approval@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userIds		List of user IDs for which approvers shall be deleted.
origin		Origin of the approval request.

Sanity

This method returns a server timestamp. It can be used to calculate the round-trip time and to verify service availability.

DateTime Sanity(
 out TpFault fault);

Needed Permission	---
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
return value		Server timestamp when the message was received.
return value		List containing the cover persons.

GetAvailableCoverPersonForIdentity

This method returns the available cover persons for the current identity.

List<CoverPersonDto> GetAvailableCoverPersonForIdentity(
 out TpFault fault,
 TpAuthentication authentication);

Needed Permission	approval@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
return value		List containing the available cover persons.

SaveCoverPersons

This method saves the cover persons.

List<CoverPersonDto> SaveCoverPersons(
 out TpFault fault,
 TpAuthentication authentication,
 List<CoverPersonSaveDto> coverPersons);

Needed Permission	approval@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
coverPersons		Cover persons to save.
return value		List containing the saved cover persons.

DeleteCoverPersons

This method deletes the cover persons for the specified users.

void DeleteCoverPersons(
 out TpFault fault,
 TpAuthentication authentication,
 List<Guid> approverIds,
 ApprovalOrigin origin);

Needed Permission	approval@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
approverIds		IDs of the users whose cover persons shall be deleted.
origin		Origin of the approval request.